This file contains API for GNSS 23 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
#include "drv_i2c_master.h"

Data Structures
struct	gnss23_s
	GNSS 23 Click context object. More...
struct	gnss23_cfg_t
	GNSS 23 Click configuration object. More...

Macros
#define	GNSS23_RSP_START "$"
	GNSS 23 response buffer commands.
#define	GNSS23_RSP_DELIMITER ","
#define	GNSS23_RSP_END "\r\n"
#define	GNSS23_RSP_GGA "GGA"
#define	GNSS23_DUMMY 0xFF
	GNSS 23 dummy data.
#define	GNSS23_GGA_ELEMENT_SIZE 15
	GNSS 23 GGA command elements.
#define	GNSS23_GGA_TIME 1
#define	GNSS23_GGA_LATITUDE 2
#define	GNSS23_GGA_LATITUDE_SIDE 3
#define	GNSS23_GGA_LONGITUDE 4
#define	GNSS23_GGA_LONGITUDE_SIDE 5
#define	GNSS23_GGA_QUALITY_INDICATOR 6
#define	GNSS23_GGA_NUMBER_OF_SATELLITES 7
#define	GNSS23_GGA_H_DILUTION_OF_POS 8
#define	GNSS23_GGA_ALTITUDE 9
#define	GNSS23_GGA_ALTITUDE_UNIT 10
#define	GNSS23_GGA_GEOIDAL_SEPARATION 11
#define	GNSS23_GGA_GEOIDAL_SEPARATION_UNIT 12
#define	GNSS23_GGA_TIME_SINCE_LAST_DGPS 13
#define	GNSS23_GGA_DGPS_REFERENCE_STATION_ID 14
#define	GNSS23_I2C_SLAVE_CR_CMD 0xAA51u
	GNSS 23 I2C settings.
#define	GNSS23_I2C_SLAVE_CW_CMD 0xAA53u
#define	GNSS23_I2C_SLAVE_CMD_LEN 8
#define	GNSS23_I2C_SLAVE_RX_LEN 4
#define	GNSS23_I2C_SLAVE_TX_LEN_REG_OFFSET 0x0008u
#define	GNSS23_I2C_SLAVE_TX_BUF_REG_OFFSET 0x2000u
#define	GNSS23_I2C_SLAVE_RX_LEN_REG_OFFSET 0x0004u
#define	GNSS23_I2C_SLAVE_RX_BUF_REG_OFFSET 0x1000u
#define	GNSS23_I2C_SLAVE_ADDRESS_CR_OR_CW 0x50
#define	GNSS23_I2C_SLAVE_ADDRESS_R 0x54
#define	GNSS23_I2C_SLAVE_ADDRESS_W 0x58
#define	GNSS23_I2C_SLAVE_MAX_ERRORS 10
#define	GNSS23_TX_DRV_BUFFER_SIZE 100
	GNSS 23 driver buffer size.
#define	GNSS23_RX_DRV_BUFFER_SIZE 800
#define	GNSS23_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Typedefs
typedef err_t(*	gnss23_master_io_t) (struct gnss23_s , uint8_t , uint16_t)
typedef struct gnss23_s	gnss23_t
	GNSS 23 Click context object.

Enumerations
enum	gnss23_drv_t { GNSS23_DRV_SEL_UART , GNSS23_DRV_SEL_I2C }
	GNSS 23 Click driver selector. More...
enum	gnss23_return_value_t { GNSS23_OK = 0 , GNSS23_ERROR = -1 }
	GNSS 23 Click return value data. More...

Functions
void	gnss23_cfg_setup (gnss23_cfg_t *cfg)
	GNSS 23 configuration object setup function.
void	gnss23_drv_interface_sel (gnss23_cfg_t *cfg, gnss23_drv_t drv_sel)
	GNSS 23 driver interface setup function.
err_t	gnss23_init (gnss23_t ctx, gnss23_cfg_t cfg)
	GNSS 23 initialization function.
err_t	gnss23_generic_write (gnss23_t ctx, uint8_t data_in, uint16_t len)
	GNSS 23 data writing function.
err_t	gnss23_generic_read (gnss23_t ctx, uint8_t data_out, uint16_t len)
	GNSS 23 data reading function.
uint8_t	gnss23_get_pps_pin (gnss23_t *ctx)
	GNSS 23 get PPS pin function.
void	gnss23_set_rst_pin (gnss23_t *ctx, uint8_t state)
	GNSS 23 set RST pin function.
void	gnss23_reset_device (gnss23_t *ctx)
	GNSS 23 reset device function.
err_t	gnss23_parse_gga (uint8_t rsp_buf, uint8_t gga_element, uint8_t element_data)
	GNSS 23 parse GGA function.

Detailed Description

This file contains API for GNSS 23 Click Driver.

Typedef Documentation

typedef err_t(* gnss23_master_io_t) (struct gnss23_s *, uint8_t *, uint16_t)

Driver serial interface.

GNSS 23 Click context object.

Context object definition of GNSS 23 Click driver.

GNSS 23 Click driver selector.

Selects target driver interface of GNSS 23 Click driver.

Enumerator
GNSS23_DRV_SEL_UART	UART driver descriptor.
GNSS23_DRV_SEL_I2C	I2C driver descriptor.

GNSS 23 Click return value data.

Predefined enum values for driver return values.

Enumerator
GNSS23_OK
GNSS23_ERROR